Bootstrap-4 Template for Zen Cart v1.5.8, v2.0.x, v2.1.0 and v2.2.x

Version 3.7.10 by lat9, drbyte, scottcwilson, marco-pm, dbltoe, dennisns7d, brittainmark, torvista, proseLA, daphilli224, retched, highburyeye and piloujp

Current Support Thread at Zen Cart Forums: https://www.zen-cart.com/showthread.php?223910-ZCA-Bootstrap-4-Template-Support-Thread

Zen Cart Download Link: https://www.zen-cart.com/downloads.php?do=file&id=2191

GitHub repository: https://github.com/lat9/ZCA-Bootstrap-Template

GitHub Wiki: https://github.com/lat9/ZCA-Bootstrap-Template/wiki

What it does

This template uses Bootstrap-4.6.2 to provide its styling and builds on the base that Raymond Barbour provided over the past few years, supporting Zen Cart versions 1.5.8 and later — best supported by zc210 and later.

Starting with v3.4.0 of the template, the template-related files needed when used with One-Page Checkout are also provided:

Bootstrap Template, Files List

The following files are provided in the current template distribution:

  1. /includes/auto_loaders/config.zca_bootstrap.php
  2. /includes/classes/ajax/zcAjaxBootstrapSearch.php (Added in v3.2.0)
  3. /includes/classes/observers/ZcaBootstrapObserver.php
  4. /includes/classes/zca/zca_message_stack.php
  5. /includes/classes/zca/zca_split_page_result.php
  6. /includes/classes/zca/zca_site_map.php
  7. /includes/extra_datafiles/dist.site-specific-bootstrap-settings.php (Added in v3.6.0)
  8. /includes/functions/zca_bootstrap_functions.php
  9. /includes/init_includes/init_zca_bootstrap.php
  10. /includes/languages/bootstrap/lang.english.php (Added in v3.7.7)
  11. /includes/languages/english/bootstrap/lang.account_history_info.php (Added in v3.6.0, removed in v3.7.7)
  12. /includes/languages/english/extra_definitions/bootstrap/*.php
  13. /includes/modules/bootstrap/*.php
  14. /includes/modules/bootstrap/centerboxes/*.php
  15. /includes/modules/pages/account_history/header_php_account_history_zca_bootstrap.php
  16. /includes/modules/pages/featured_products/header_php_featured_products_zca_bootstrap.php
  17. /includes/modules/pages/page_not_found/header_php_page_not_found_zca_bootstrap.php
  18. /includes/modules/pages/product_reviews/header_php_product_reviews_zca_bootstrap.php
  19. /includes/modules/pages/product_reviews_info/header_php_product_reviews_info_zca_bootstrap.php
  20. /includes/modules/pages/product_reviews_write/header_php_product_reviews_write_zca_bootstrap.php
  21. /includes/modules/pages/products_all/header_php_products_all_zca_bootstrap.php
  22. /includes/modules/pages/products_new/header_php_products_new_zca_bootstrap.php
  23. /includes/modules/pages/shopping_cart/header_php_shopping_cart_zca_bootstrap.php
  24. /includes/modules/pages/shopping_cart/jscript_addr_pulldowns_bootstrap.php (Added in v3.6.4)
  25. /includes/modules/pages/site_map/header_php_site_map_zca_bootstrap.php
  26. /includes/modules/pages/specials/header_php_specials_zca_bootstrap.php
  27. /includes/modules/sideboxes/bootstrap/*.php
  28. /includes/templates/bootstrap/*.*
  29. /YOUR_ADMIN/zca_bootstrap_colors.php
  30. /YOUR_ADMIN/includes/auto_loaders/config.bc.php
  31. /YOUR_ADMIN/includes/auto_loaders/config.zca_bootstrap_admin.php
  32. /YOUR_ADMIN/includes/css/colorpicker.css
  33. /YOUR_ADMIN/includes/extra_datafiles/zca_bootstrap_colors.php
  34. /YOUR_ADMIN/includes/functions/extra_functions/zen_cfg_read_only.php (Added in v3.2.0)
  35. /YOUR_ADMIN/includes/init_includes/init_bc_config.php
  36. /YOUR_ADMIN/includes/init_includes/init_bc_config_install_or_upgrade.php (Added in v3.5.2)
  37. /YOUR_ADMIN/includes/init_includes/init_zca_bootstrap_template_admin.php
  38. /YOUR_ADMIN/includes/init_includes/init_zca_bootstrap_template_admin_install.php (Added in v3.2.0)
  39. /YOUR_ADMIN/includes/init_includes/init_zca_bootstrap_template_admin_update.php (Added in v3.2.0)
  40. /YOUR_ADMIN/includes/javascript/colorpicker.js
  41. /YOUR_ADMIN/includes/languages/english/zca_bootstrap_colors.php
  42. /YOUR_ADMIN/includes/languages/english/extra_definitions/zca_bootstrap_colors.php
  43. /YOUR_ADMIN/includes/languages/english/extra_definitions/zca_bootstrap_messages.php

Initial Installation

This template currently distributes no core-file overwrite; you should always backup your cart's database and files prior to making any changes.

  1. Unzip the template's package file, which you've most likely already done if you're reading this!
  2. Rename the distribution's YOUR_ADMIN sub-directory to match the name of your site's Zen Cart admin directory.
  3. Copy the files present in the includes and the renamed YOUR_ADMIN sub-directories to your site's file-system.
  4. Log into your Zen Cart admin to allow the template's initialization to be run. If you want to enable the template:

As a suggestion, keep the as-distributed bootstrap template's files unmodified so that you can easily revert to see if your custom changes have affected the template's output. Once you have installed the template and customized its sidebox use, you can clone the template for use on your site.

Note: If you've made an initial installation of the template — as you should — in a test version of your live site, you've most likely customized the coloring to match your site. You can use the template's admin "Tools :: ZCA Bootstrap Colors" tool to download a CSV format of your coloring (see the bottom of that tool) and then upload that CSV once you're ready to enable the template on your live site!

Upgrading

This readme's Version History section, below, identifies each file changed, added or removed for each release of the template, starting with v3.0.0. When you're upgrading, note each of the changes from your currently-installed version to that associated with the upgrade. Pay specific attention to the files added and removed!

Unzip the template's package file and use a file-comparison program (like WinMerge or BeyondCompare) to either overwrite (if you've made a clone of the template) or merge the differences into the 'base' bootstrap sub-directories. If you haven't made a clone of the template, pay specific attention to any changes that you've made to those 'base' files! If you have made a clone, use your file-comparison program to merge the 'base' template's updates into your cloned copy. In either case, pay specific attention to the files added and removed!

Version-Specific Upgrade Suggestions

Sometimes, a template-upgrade introduces new language constants and/or color-configuration values. When this occurs, I'll suggest that you place your site into Maintenance Mode until the upgrade is completed. Otherwise, it's possible that the site's storefront will experience PHP Warnings (at best) or PHP Errors (if the site runs on more strict versions of PHP) due to the template's use of those missing constants.

The following version-upgrades apply to this suggestion:

Version History

This section identifies the template's version history and changes, starting with its v2.0.0c release. Prior version changes can be found in the root of the template's distribution zip-file (CHANGELOG.txt).